<html>
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    <title>buffer_size</title>
    <link rel="stylesheet" href="../../boostbook.css" type="text/css">
    <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
    <link rel="home" href="../../index.html" title="Asio">
    <link rel="up" href="../reference.html" title="Reference">
    <link rel="prev" href="buffer_sequence_end/overload6.html" title="buffer_sequence_end (6 of 6 overloads)">
    <link rel="next" href="buffered_read_stream.html" title="buffered_read_stream">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
    <tr>
        <td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../asio.png"></td>
    </tr>
</table>
<hr>
<div class="spirit-nav">
    <a accesskey="p" href="buffer_sequence_end/overload6.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u"
                                                                                                           href="../reference.html"><img
        src="../../up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../home.png"
                                                                                      alt="Home"></a><a accesskey="n"
                                                                                                        href="buffered_read_stream.html"><img
        src="../../next.png" alt="Next"></a>
</div>
<div class="section">
    <div class="titlepage">
        <div>
            <div><h3 class="title">
                <a name="asio.reference.buffer_size"></a><a class="link" href="buffer_size.html" title="buffer_size">buffer_size</a>
            </h3></div>
        </div>
    </div>
    <p>
        <a class="indexterm" name="asio.indexterm.buffer_size"></a>
    </p>
    <p>
        Get the total number of bytes in a buffer sequence.
    </p>
    <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
    <span class="keyword">typename</span> <span class="identifier">BufferSequence</span><span
                class="special">&gt;</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span
                class="identifier">buffer_size</span><span class="special">(</span>
    <span class="keyword">const</span> <span class="identifier">BufferSequence</span> <span class="special">&amp;</span> <span
                class="identifier">b</span><span class="special">);</span>
</pre>
    <p>
        The <code class="computeroutput"><span class="identifier">buffer_size</span></code> function
        determines the total size of all buffers in the buffer sequence, as if computed
        as follows:
    </p>
    <pre class="programlisting"><span class="identifier">size_t</span> <span class="identifier">total_size</span> <span
            class="special">=</span> <span class="number">0</span><span class="special">;</span>
<span class="keyword">auto</span> <span class="identifier">i</span> <span class="special">=</span> <span
                class="identifier">asio</span><span class="special">::</span><span class="identifier">buffer_sequence_begin</span><span
                class="special">(</span><span class="identifier">buffers</span><span class="special">);</span>
<span class="keyword">auto</span> <span class="identifier">end</span> <span class="special">=</span> <span
                class="identifier">asio</span><span class="special">::</span><span class="identifier">buffer_sequence_end</span><span
                class="special">(</span><span class="identifier">buffers</span><span class="special">);</span>
<span class="keyword">for</span> <span class="special">(;</span> <span class="identifier">i</span> <span
                class="special">!=</span> <span class="identifier">end</span><span class="special">;</span> <span
                class="special">++</span><span class="identifier">i</span><span class="special">)</span>
<span class="special">{</span>
  <span class="identifier">const_buffer</span> <span class="identifier">b</span><span class="special">(*</span><span
                class="identifier">i</span><span class="special">);</span>
  <span class="identifier">total_size</span> <span class="special">+=</span> <span class="identifier">b</span><span
                class="special">.</span><span class="identifier">size</span><span class="special">();</span>
<span class="special">}</span>
<span class="keyword">return</span> <span class="identifier">total_size</span><span class="special">;</span>
</pre>
    <p>
        The <code class="computeroutput"><span class="identifier">BufferSequence</span></code> template
        parameter may meet either of the <code class="computeroutput"><span
            class="identifier">ConstBufferSequence</span></code>
        or <code class="computeroutput"><span class="identifier">MutableBufferSequence</span></code>
        type requirements.
    </p>
    <h5>
        <a name="asio.reference.buffer_size.h0"></a>
        <span><a name="asio.reference.buffer_size.requirements"></a></span><a class="link"
                                                                              href="buffer_size.html#asio.reference.buffer_size.requirements">Requirements</a>
    </h5>
    <p>
        <span class="emphasis"><em>Header: </em></span><code class="literal">asio/buffer.hpp</code>
    </p>
    <p>
        <span class="emphasis"><em>Convenience header: </em></span><code class="literal">asio.hpp</code>
    </p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%">
    <tr>
        <td align="left"></td>
        <td align="right">
            <div class="copyright-footer">Copyright © 2003-2022 Christopher M. Kohlhoff<p>
                Distributed under the Boost Software License, Version 1.0. (See accompanying
                file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
            </p>
            </div>
        </td>
    </tr>
</table>
<hr>
<div class="spirit-nav">
    <a accesskey="p" href="buffer_sequence_end/overload6.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u"
                                                                                                           href="../reference.html"><img
        src="../../up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../home.png"
                                                                                      alt="Home"></a><a accesskey="n"
                                                                                                        href="buffered_read_stream.html"><img
        src="../../next.png" alt="Next"></a>
</div>
</body>
</html>
